The NavigationManipulator supports these navigation directions and default keyboard keys for them: More...

#include <kanzi/core.ui/input/navigation_manipulator.hpp>

Inheritance diagram for kanzi::NavigationManipulator:

Classes
class	KeyNavigationMessageArguments

Public Member Functions
template<typename... Directions>
void	disableNavigationDirections (Directions... directions)
	Disables a set of navigation directions.

template<typename... Directions>
void	enableNavigationDirections (Directions... directions)
	Enables a set of navigation directions.

tuple< LogicalKey, KeyModifier >	getNavigationDirection (NavigationDirection direction) const
	Returns the LogicalKey and KeyModifier values of a navigation direction.

bool	isNavigationDirectionEnabled (NavigationDirection direction) const
	Checks whether a navigation direction is enabled in the manipulator.

void	setNavigationDirection (NavigationDirection direction, tuple< LogicalKey, KeyModifier > key)
	Sets the LogicalKey and KeyModifier values for a navigation direction.

void	setNavigationDirectionEnabled (NavigationDirection direction, bool enabled)
	Sets the enabled state of a navigation direction.

Public Member Functions inherited from kanzi::InputManipulator
void	attach (Node &node)
	Attaches an input manipulator to a node.

void	cancel ()
	Notify manipulator of touch canceling.

void	detach ()
	Detaches an input manipulator.

Node *	getAttachedNode () const
	Gets the node to which the input manipulator is attached.

InputManipulator *	getDependantManipulator () const
	Gets the dependant input manipulator.

EventRoutingMode	getEventRoutingMode ()
	Returns the current input event routing mode.

InputManipulatorWeakPtr	getFailManipulator () const
	Gets the fail manipulator.

State	getState () const
	Get the state of an input manipulator.

KZ_DEPRECATED TouchEventRoutingMode	getTouchEventRoutingMode ()
	Returns the current touch event routing mode.

ManipulatorType	getType () const
	Returns the type of the input manipulator.

bool	isActive () const
	Checks whether an input manipulator is in active state.

bool	isAttached () const
	Tells whether the input manipulator is attached to a node.

bool	isCancelable () const
	Returns whether an input manipulator is in a cancelable state.

bool	isResettable () const
	Returns whether an input manipulator is in a resettable state.

void	requireToFail (InputManipulatorWeakPtr manipulatorToFail)
	Sets the input manipulator that must fail before Kanzi can recognize this input manipulator.

void	reset ()
	Reset the manipulator.

void	setEventRoutingMode (EventRoutingMode mode)
	Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators.

void	setReferenceNode (NodeWeakPtr referenceNode)
	Override the attached node as the hit test reference node.

void	setState (State state)
	Set the state of an input manipulator.

KZ_DEPRECATED void	setTouchEventRoutingMode (TouchEventRoutingMode mode)
	Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators.

	~InputManipulator () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static NavigationManipulatorSharedPtr	create (Domain *domain, string_view="")
	Creates a NavigationManipulator instance.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Types
using	NavigationGestureContainer
	The container type with the navigation key gestures.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Member Functions
template<typename TArgumentsType >
void	dispatchNavigationMessage (const MessageType< TArgumentsType > &message, const NavigationGesture &gesture)

	NavigationManipulator (Domain *domain)
	Constructor.

bool	notifyKeyInput (const KeyEvent &event) override
	Overrides InputManipulator::notifyKeyInput().

void	onCancel () override
	Overrides InputManipulator::onCancel().

void	onKeyPressGesture (KeyGestureInfo &) override
	Overrides InputManipulator::onKeyPressGesture().

void	onKeyReleaseGesture (KeyGestureInfo &) override
	Overrides InputManipulator::onKeyPressGesture().

void	onReset () override
	Overrides InputManipulator::onReset().

Protected Member Functions inherited from kanzi::InputManipulator
void	addHitTestArguments (MessageArguments &message, const TouchPoint &touchPoint)
	Add hit test information arguments to the message from the touch point.

bool	detectKeyGesture (const KeyEvent &event, KeyGestureInfo &gesture)
	Detects key gestures from the event that you pass as an argument.

Node2D *	findNearestParent2D ()
	Find the 2D manipulator node for this input manipulator.

InputManager *	getInputManager () const
	Get the attached input manager of an input manipulator.

	InputManipulator (Domain *domain, ManipulatorType type=ManipulatorType::TouchInputHandler)
	Constructor.

virtual bool	isCancelableOverride () const
	Overridable check for the cancelable status of an input manipulator.

virtual bool	isResettableOverride () const
	Overridable check for the resettable status of an input manipulator.

void	markTouchPointConsumed (const TouchPoint &touchPoint)
	Marks the passed touch point handled.

virtual void	notifyTouchInside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur inside the subtree of the input manipulator.

virtual void	notifyTouchOutside (const TouchInfo &touchInfo)
	Notify an input manipulator about touch events that occur outside the subtree of the input manipulator.

virtual void	onAttach ()
	Attach function for input manipulators.

virtual void	onDetach ()
	Detach function for input manipulators.

virtual void	onFail ()
	Fail function for input manipulators.

virtual void	onPartialKeyPressGesture (KeyGestureInfo &gesture)
	The detectKeyGesture() method calls this method when it detects a partial key press gesture.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Attributes
NavigationGesture *	m_activeNaviGesture
	The pointer to the active navigation gesture.

NavigationGestureContainer	m_naviKeys
	The navigation key gesture detector instances.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Messages
Message arguments used by the navigation messages.
using	KeyNavigationMessageType
	Generic type declaration of the message types used by the manipulator.

static KeyNavigationMessageType	KeyNavigationStartedMessage
	Kanzi dispatches this message to the attached node when the application user presses the key(s) specified for a navigation direction.

static KeyNavigationMessageType	KeyNavigationFinishedMessage
	Kanzi dispatches this message to the attached node when the application user releases the key(s) specified for a navigation direction.

static KeyNavigationMessageType	KeyNavigationCanceledMessage
	Kanzi dispatches this message to the attached node when Kanzi cancels the navigation manipulator from capturing the current navigation gesture.

Additional Inherited Members
Public Types inherited from kanzi::InputManipulator
enum	EventRoutingMode { RoutingBubbling , RoutingTunneling }
	Enumeration for the available input event routing modes. More...

enum class	ManipulatorType { TouchInputHandler , KeyInputHandler }
	Enumeration for the input manipulator type. More...

enum	State { StateReady , StatePossible , StateBegin , StateChange , StateEnd , StateFail , StateDelayed , StateCanceled }
	Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More...

using	TouchEventRoutingMode
	Enumeration for the available touch event routing modes.

using	TouchPointsConstIterator

using	TouchPointsContainer

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

The NavigationManipulator supports these navigation directions and default keyboard keys for them:

Up: Up Arrow key
Down: Down Arrow key
Left: Left Arrow key
Right: Right Arrow key
Home: Home key
End: End key
Page up: Page Up key
Page down: Page Down key

The manipulator recognizes only one navigation key gesture at a time. When Kanzi recognizes a key-pressed gesture for a navigation key, the manipulator grabs the key input and blocks any key input until Kanzi recognizes the key-released gesture for the pressed navigation key.

When the user presses, holds down, releases, or cancels a navigation key, Kanzi dispatches a dedicated message for each navigation key. Kanzi dispatches a key-pressed message when the manipulator detects the key- pressed, key-hold, or key-repeat gesture. When focus moves, Kanzi cancels a key-pressed and key-hold gesture. You can cancel a key-pressed gesture for a navigation key with the cancel() method.

See also: Inputmanipulator

Since: Kanzi 3.8.0

Member Typedef Documentation

◆ KeyNavigationMessageType

using kanzi::NavigationManipulator::KeyNavigationMessageType

Generic type declaration of the message types used by the manipulator.

◆ NavigationGestureContainer

using kanzi::NavigationManipulator::NavigationGestureContainer

protected

The container type with the navigation key gestures.

Constructor & Destructor Documentation

◆ NavigationManipulator()

kanzi::NavigationManipulator::NavigationManipulator ( Domain * domain )

explicitprotected

Constructor.

Member Function Documentation

◆ create()

static NavigationManipulatorSharedPtr kanzi::NavigationManipulator::create	(	Domain *	domain,
		string_view	= "" )

inlinestatic

Creates a NavigationManipulator instance.

Parameters

domain The domain to which the NavigationManipulator instance belongs.

◆ isNavigationDirectionEnabled()

bool kanzi::NavigationManipulator::isNavigationDirectionEnabled ( NavigationDirection direction ) const

Checks whether a navigation direction is enabled in the manipulator.

Parameters

direction The navigation direction identifier to check.

Returns: If the navigation direction is enabled, returns true, otherwise false.

Since: Kanzi 3.9.0

◆ setNavigationDirectionEnabled()

void kanzi::NavigationManipulator::setNavigationDirectionEnabled	(	NavigationDirection	direction,
		bool	enabled )

Sets the enabled state of a navigation direction.

Kanzi ignores the disabled navigation directions when recognizing navigation key gestures.

Parameters

direction	The navigation direction identifier to enable.
enabled	To enable the navigation direction, pass true, otherwise pass false as an argument.

Since: Kanzi 3.9.0

◆ enableNavigationDirections()

template<typename... Directions>

void kanzi::NavigationManipulator::enableNavigationDirections ( Directions... directions )

inline

Enables a set of navigation directions.

Template Parameters

Directions The navigation direction types.

Parameters

directions The navigation directions to enable.

Since: Kanzi 3.9.0

◆ disableNavigationDirections()

template<typename... Directions>

void kanzi::NavigationManipulator::disableNavigationDirections ( Directions... directions )

inline

Disables a set of navigation directions.

Template Parameters

Directions The navigation direction types.

Parameters

directions The navigation directions to disable.

Since: Kanzi 3.9.0

◆ getNavigationDirection()

tuple< LogicalKey, KeyModifier > kanzi::NavigationManipulator::getNavigationDirection ( NavigationDirection direction ) const

Returns the LogicalKey and KeyModifier values of a navigation direction.

Parameters

direction The navigation direction for which to return the navigation key arguments.

Returns

A tuple with:

The LogicalKey specified for the navigation direction.
The KeyModifier specified for the navigation direction.

Since: Kanzi 3.9.0

◆ setNavigationDirection()

void kanzi::NavigationManipulator::setNavigationDirection	(	NavigationDirection	direction,
		tuple< LogicalKey, KeyModifier >	key )

Sets the LogicalKey and KeyModifier values for a navigation direction.

Parameters

direction	The navigation direction to set the key values.
key	A tuple with: The LogicalKey that is set for the navigation direction. The KeyModifier that is set for the navigation direction.

Since: Kanzi 3.9.0

◆ notifyKeyInput()

bool kanzi::NavigationManipulator::notifyKeyInput ( const KeyEvent & event )

overrideprotectedvirtual

Overrides InputManipulator::notifyKeyInput().

Reimplemented from kanzi::InputManipulator.

◆ onCancel()

void kanzi::NavigationManipulator::onCancel ( )

overrideprotectedvirtual

Overrides InputManipulator::onCancel().

Reimplemented from kanzi::InputManipulator.

◆ onReset()

void kanzi::NavigationManipulator::onReset ( )

overrideprotectedvirtual

Overrides InputManipulator::onReset().

Reimplemented from kanzi::InputManipulator.

◆ onKeyPressGesture()

void kanzi::NavigationManipulator::onKeyPressGesture ( KeyGestureInfo & )

overrideprotectedvirtual

Overrides InputManipulator::onKeyPressGesture().

Reimplemented from kanzi::InputManipulator.

◆ onKeyReleaseGesture()

void kanzi::NavigationManipulator::onKeyReleaseGesture ( KeyGestureInfo & )

overrideprotectedvirtual

Overrides InputManipulator::onKeyPressGesture().

Reimplemented from kanzi::InputManipulator.

◆ dispatchNavigationMessage()

template<typename TArgumentsType >

void kanzi::NavigationManipulator::dispatchNavigationMessage	(	const MessageType< TArgumentsType > &	message,
		const NavigationGesture &	gesture )

inlineprotected

Member Data Documentation

◆ KeyNavigationStartedMessage

KeyNavigationMessageType kanzi::NavigationManipulator::KeyNavigationStartedMessage

static

Kanzi dispatches this message to the attached node when the application user presses the key(s) specified for a navigation direction.

Since: Kanzi 3.9.0

◆ KeyNavigationFinishedMessage

KeyNavigationMessageType kanzi::NavigationManipulator::KeyNavigationFinishedMessage

static

Kanzi dispatches this message to the attached node when the application user releases the key(s) specified for a navigation direction.

Since: Kanzi 3.9.0

◆ KeyNavigationCanceledMessage

KeyNavigationMessageType kanzi::NavigationManipulator::KeyNavigationCanceledMessage

static

Kanzi dispatches this message to the attached node when Kanzi cancels the navigation manipulator from capturing the current navigation gesture.

Since: Kanzi 3.9.0

◆ m_naviKeys

NavigationGestureContainer kanzi::NavigationManipulator::m_naviKeys

protected

The navigation key gesture detector instances.

◆ m_activeNaviGesture

NavigationGesture* kanzi::NavigationManipulator::m_activeNaviGesture

protected

The pointer to the active navigation gesture.

The documentation for this class was generated from the following file:

kanzi/core.ui/input/navigation_manipulator.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Messages

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ KeyNavigationMessageType

◆ NavigationGestureContainer

Constructor & Destructor Documentation

◆ NavigationManipulator()

Member Function Documentation

◆ create()

◆ isNavigationDirectionEnabled()

◆ setNavigationDirectionEnabled()

◆ enableNavigationDirections()

◆ disableNavigationDirections()

◆ getNavigationDirection()

◆ setNavigationDirection()

◆ notifyKeyInput()

◆ onCancel()

◆ onReset()

◆ onKeyPressGesture()

◆ onKeyReleaseGesture()

◆ dispatchNavigationMessage()

Member Data Documentation

◆ KeyNavigationStartedMessage

◆ KeyNavigationFinishedMessage

◆ KeyNavigationCanceledMessage

◆ m_naviKeys

◆ m_activeNaviGesture